Request For Payment Cancellation Response

The RequestForPaymentCancellationResponse API enables to repond the respective payment cancellation request from the originator.

Method: POST

{{URL}}/rtp/rpc/TransactionService/RequestForPaymentCancellationResponse

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
caseId Mandatory	String Case ID of inbound Request for Payment cancellation request Example – "RFPCINCASE202308170000000001"
referenceNumber Mandatory	String Reference number of the inbound Request for Payment Example – "20230823267084131z6WMAe3eBJYfNem"
reasonCode Mandatory	String Reason code for cancelling the request Example – "AC02"
status Mandatory	String Response status of request cancellation Example – "CNCL"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/RequestForPaymentCancellationResponse' \
--header 'Content-Type: application/json' \
--data '{"caseId":"RFPCINCASE202308170000000001","referenceNumber":"20230823267084131z6WMAe3eBJYfNem","reasonCode":"AC02","status":"CNCL","processor":"FEDNOW"}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/RequestForPaymentCancellationResponse", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""caseId"": ""RFPCINCASE202308170000000001"",
" + "\n" +
@"    ""referenceNumber"": ""20230823267084131z6WMAe3eBJYfNem"",
" + "\n" +
@"    ""reasonCode"": ""AC02"",
" + "\n" +
@"    ""status"": ""CNCL"",
" + "\n" +
@"    ""processor"": ""FEDNOW""
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/RequestForPaymentCancellationResponse"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "caseId": "RFPCINCASE202308170000000001",`+"
"+`
    "referenceNumber": "20230823267084131z6WMAe3eBJYfNem",`+"
"+`
    "reasonCode": "AC02",`+"
"+`
    "status": "CNCL",`+"
"+`
    "processor": "FEDNOW"`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/RequestForPaymentCancellationResponse',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "caseId": "RFPCINCASE202308170000000001",
  "referenceNumber": "20230823267084131z6WMAe3eBJYfNem",
  "reasonCode": "AC02",
  "status": "CNCL",
  "processor": "FEDNOW"
});

req.write(postData);

req.end();

Request Body (Applicable only for FedNow)

{
    "caseId": "RFPCINCASE202308170000000001",
    "referenceNumber": "20230823267084131z6WMAe3eBJYfNem",
    "reasonCode": "AC02",
    "status": "CNCL",
    "processor": "FEDNOW"
}

Response: 200

Response Parameters

Parameter	Description
message	String Notification message for the transaction Example – "success"
rawMessage	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
response	String Response received for the given request Example – "JSON Representation of Received Response"
status	String Status of the response Example – "FAILED"

Response Body (Applicable only for FedNow)

{
  "message": "success",
  "rawMessage": "Base64 Value of Received Response",
  "response": "JSON Representation of Received Response",
  "status": "FAILED"
}